Overview of New APIs in the Current Release

  1. Suspense and Policy Withholdings API

  2. Rates and RateGroups API

  3. Workflow Tasks API

  4. Requirements and Requirement Results API

  5. Patch Services API

  6. Health Check API

Suspense and Policy Withholdings API

As part of the ongoing expansion of OIPA RESTful APIs, this release introduces enhanced integration capabilities for Suspense and Policy Withholding entities. The new service endpoints now support CRUD (Create, Read, Update, Delete) and search operations via the OIPA Service Layer.

New API endpoints and methods:

  • Suspense: GET, PUT, POST, PATCH, DELETE

  • Withholding (Policy): GET, PUT, POST, PATCH

These enhancements enable third-party applications to seamlessly perform operations and integrate more effectively within the OIPA ecosystem.

Rates and RateGroups API

As part of the ongoing expansion of OIPA RESTful APIs, this release introduces enhanced integration capabilities for Rates, RateGroups and RateGroupRelationships entities. The new service endpoints now support CRUD (Create, Read, Update, Delete) and search operations via the OIPA Service Layer.

New API endpoints:

  • Rates: GET, PUT, POST, PATCH, DELETE

  • RateGroups: GET, PUT, POST, PATCH

  • RateGroupRelationships: GET, PUT, POST, PATCH, DELETE

This enhancement helps customers to perform operations on rates and its related objects using API's.

Workflow Tasks API

As part of the ongoing expansion of OIPA RESTful APIs, this release allows users to perform CRUD (Create, Read, Update, Delete) and search operations on workflow entities, providing greater flexibility and integration capabilities.

New API endpoints and methods:

  • WorkflowTasks: GET, PUT, POST, PATCH

This enhancement helps customers by improving employee productivity, enabling better time management, and enhancing task prioritization.

Requirements and Requirement Results API

Client-level requirements are created and managed in OIPA using the Requirements screen. Likewise, the Requirement Results section displays outcomes that can be received either manually or electronically. The OIPA REST API enables users to perform Create, Read, Update, and Delete (CRUD) operations for both client-level requirements and requirement results.

New API endpoints and methods:

  • Client Requirements: GET, PUT, POST, PATCH, DELETE

  • Requirement Results: GET, PUT, POST, PATCH

This feature expands integration with OIPA by enabling additional requirement-related entities, delivering greater flexibility and efficiency.

Patch Services API

This enhancement introduces PATCH support for various entities in OIPA and details which fields can or cannot be updated using PATCH requests.

Previously, the service layer supported only the PUT method for updating entity records such as Policy and Client. The PUT method requires the full payload, overwriting the entire object during updates. In contrast, the PATCH method allows partial updates, so you only need to provide the fields you wish to change; only those fields will be updated.

Extends PATCH service to Policy, Segment, Role, Requirement, Client, Address, Phone, Case, Group Customer, Domains, Users, OutboundApplications, OutboundSecurities.

New API endpoints and methods:

  • Policy: PATCH

  • Segment: PATCH

  • Role: PATCH

  • Requirement: PATCH

  • Client: PATCH

  • Address: PATCH

  • Phone: PATCH

  • Case: PATCH

  • Group Customer: PATCH

  • Domains: PATCH

  • OutboundApplications: PATCH

  • OutboundSecurities: PATCH

This enhancement minimizes the effort required by eliminating the need to provide a full payload or re-enter values that do not require updating.

Health Check API

This API is used to monitor the health, liveness and readiness for PasJava, PasService and CycleService.

New API endpoints and methods:

  • Health: GET

  • Liveliness: GET

  • Readiness: GET

This enhancement assists in providing the health check reports which are helpful to know the health status of available services.